home *** CD-ROM | disk | FTP | other *** search
/ Java Programmer's Toolkit / Java Programmer's Toolkit.iso / hotjava3 / hotjava3.exe / hotjava / classsrc / java / io / FileInputStream.java < prev    next >
Encoding:
Java Source  |  1995-08-11  |  4.4 KB  |  155 lines
  1. /*
  2.  * @(#)FileInputStream.java    1.15 95/05/21 Arthur van Hoff
  3.  *
  4.  * Copyright (c) 1994 Sun Microsystems, Inc. All Rights Reserved.
  5.  *
  6.  * Permission to use, copy, modify, and distribute this software
  7.  * and its documentation for NON-COMMERCIAL purposes and without
  8.  * fee is hereby granted provided that this copyright notice
  9.  * appears in all copies. Please refer to the file "copyright.html"
  10.  * for further important copyright and licensing information.
  11.  *
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
  13.  * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
  14.  * TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  15.  * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR
  16.  * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
  17.  * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
  18.  */
  19.  
  20. package java.io;
  21. import java.io.File;
  22.  
  23. /**
  24.  * File input stream, can be constructed from
  25.  * a file descriptor or a file name.
  26.  * @see    FileOutputStream
  27.  * @see    File
  28.  * @version     1.15, 21 May 1995
  29.  * @author    Arthur van Hoff
  30.  */
  31. public
  32. class FileInputStream extends InputStream {
  33.     /**
  34.      * The system-dependent file descriptor.
  35.      */
  36.     private int fd = -1;
  37.  
  38.     /**
  39.      * Creates an input file given a file name.
  40.      * @param name the file name (very system dependent)
  41.      * @exception IOException i/o error occurred, file not found
  42.      */
  43.     public FileInputStream(String name) {
  44.     this.fd = open(name);
  45.     }
  46.     
  47.     /**
  48.      * Creates an input file given a file descriptor.
  49.      * @param fd    the file descriptor (very system dependent)
  50.      * @exception IOException i/o error occurred
  51.      */
  52.     public FileInputStream(int fd) {
  53.     this.fd = openfd(fd);
  54.     }
  55.     
  56.     /**
  57.      * Creates an input file given a File object.
  58.      * @param file the file to be opened for reading
  59.      * @exception IOException i/o error occurred, file not found
  60.      */
  61.     public FileInputStream(File file) {
  62.     this(file.getPath());
  63.     }
  64.  
  65.     /**
  66.      * Opens a file for reading.
  67.      */
  68.     private native int open(String name);
  69.  
  70.     /**
  71.      * Uses a file descriptor for reading.
  72.      */
  73.     private native int openfd(int fd);
  74.  
  75.     /**
  76.      * Reads a byte. Will block if no input is available.
  77.      * @return     the byte read, or -1 if the end of the
  78.      *        stream is reached.
  79.      * @exception IOException i/o error occurred
  80.      */
  81.     public native int read();
  82.  
  83.     private native int readBytes(byte b[], int off, int len);
  84.  
  85.     /**
  86.      * Reads into an array of bytes.
  87.      * Blocks until some input is available.
  88.      * @param b    the buffer into which the data is read
  89.      * @return  the actual number of bytes read, -1 is
  90.      *         returned when the end of the stream is reached.
  91.      * @exception IOException i/o error occurred
  92.      */
  93.     public int read(byte b[]) {
  94.     return readBytes(b, 0, b.length);
  95.     }
  96.  
  97.     /**
  98.      * Reads into an array of bytes.
  99.      * Blocks until some input is available.
  100.      * For efficiency,this method should be overridden in a subclass
  101.      * (the default implementation reads 1 byte
  102.      * at a time).
  103.      * @param b    the buffer into which the data is read
  104.      * @param off the start offset of the data
  105.      * @param len the maximum number of bytes read
  106.      * @return  the actual number of bytes read, -1 is
  107.      *         returned when the end of the stream is reached.
  108.      * @exception IOException i/o error occurred
  109.      */
  110.     public int read(byte b[], int off, int len) {
  111.     return readBytes(b, off, len);
  112.     }
  113.  
  114.     /**
  115.      * Skips bytes of input.
  116.      * @param n     bytes to be skipped
  117.      * @return    actual number of bytes skipped
  118.      * @exception IOException i/o error occurred
  119.      */
  120.     public native int skip(int n);
  121.  
  122.     /**
  123.      * Returns the number of bytes that can be read
  124.      * without blocking.
  125.      * @return the number of available bytes, which is initially
  126.      *        equal to the file size
  127.      */
  128.     public native int available();
  129.  
  130.     /**
  131.      * Closes the input stream. Must be called
  132.      * to release any resources associated with
  133.      * the stream.
  134.      * @exception IOException i/o error occurred
  135.      */
  136.     public synchronized native void close();
  137.  
  138.     /**
  139.      * Returns the file descriptor associated with this stream.
  140.      */
  141.     public final int getFD() {
  142.     return fd;
  143.     }
  144.  
  145.     /**
  146.      * Close the stream when garbage is collected.
  147.      */
  148.     protected void finalize() {
  149.         try {
  150.         close();
  151.     } catch (Exception e) {
  152.     }    
  153.     }
  154. }
  155.